บทท 13 การทาเอกสารประกอบโปรแกรม

Transcription

1 บทท 13 การทาเอกสารประกอบโปรแกรม การทาเอกสารประกอบโปรแกรมเป นงานท ส าค ญของการพ ฒนาโปรแกรม เอกสาร ประกอบโปรแกรมช วยให ผ ใช โปรแกรมเข าใจว ตถ ประสงค ข อม ลท จะต องใช ก บ โปรแกรม ตลอดจนผลล พธ ท จะได จากโปรแกรม การทาโปรแกรมท กโปรแกรมจ งควร ต องทาเอกสารกาก บ เพ อใช ส าหร บการอ างอ งเม อจะใช งานโปรแกรมและเม อต องการ แก ไขปร บปร งโปรแกรม เอกสารประกอบโปรแกรมท จ ดทา ประกอบด วยห วข อต อไปน 1. ว ตถ ประสงค 2. ประเภทและชน ดของคอมพ วเตอร และอ ปกรณ ท ใช ในโปรแกรม 3. ว ธ การใช โปรแกรม 4. แนวค ดเก ยวก บการออกแบบโปรแกรม 5. รายละเอ ยดโปรแกรม 6. ข อม ลต วแทนท ใช ทดสอบ 7. ผลล พธ ของการทดสอบ การท าเอกสารประกอบโปรแกรม ค อการอธ บายในรายละเอ ยดของโปรแกรม จ ดประสงค ของโปรแกรมค ออะไร ใช งานในด านไหน ซ งอาจจะสร ปเป นรายละเอ ยด ของโปรแกรมและแสดงเป นผ งงาน (Flowchart) โปรแกรมเมอร ท ด ควรจะม การทา เอกสารประกอบโปรแกรมท กข นตอนของการพ ฒนาโปรแกรม ว าจะเป นข นตอนการ ออกแบบ การเข ยนโปรแกรม หร อข นตอนในการทดสอบโปรแกรม ซ งข นตอนในการ ทาเอกสารน จะม ประโยชน อย างมากต อหน วยงาน เน องจากบางคร งอาจต องการ เปล ยนแปลงแก ไขโปรแกรมท ได ม การทาสาเร จไปนานแล ว เพ อให ตรงก บความต องการ ท เปล ยนไป จะทาให สามารถทาความเข าใจก บโปรแกรมได ง ายข นและจะเป นการ

2 336 สะดวกต อผ ท ต องเข าร บช วงงานต อในภายหล ง ในการจ ดทาเอกสารประกอบโปรแกรม จะม อย 2 แบบค อ 1. เอกสารประกอบโปรแกรมสาหร บผ ใช (User Documentation) จะเหมาะสาหร บผ ใช ท ไม เก ยวข องก บการพ ฒนาโปรแกรม แต เป นผ ท ใช งานโปรแกรมอย างเด ยว และจะใช เป น เอกสารในการอธ บายการใช โปรแกรมอย างเด ยว เช น 1.1 โปรแกรมน ใช งานอะไรได บ าง ใช งานในด านใด 1.2 ข อม ลท ต องป อนเข าม ล กษณะอย างไร 1.3 ข อม ลออกหร อการแสดงผลม ล กษณะอย างไร 1.4 การเร ยกใช โปรแกรมทาอย างไร 1.5 คาส งหร อข อม ลท จาเป นให โปรแกรมเร มทางาน ม อะไรบ าง 2. เอกสารประกอบโปรแกรมส าหร บผ เข ยนโปรแกรม (Technical Documentation) ผ เข ยนโปรแกรมควรทาเอกสารประกอบไว เพ อให ง ายต อการเปล ยนแปลงโปรแกรมใน ภายหล ง ซ งเอกสารจะแบ งออกเป น 2 ส วนค อ 2.1 ส วนท เป นคาอธ บายหร อหมายเหต (Comment) ในโปรแกรม ซ งส วนใหญ ม กเข ยนแทรกอย ในโปรแกรม ใช อธ บายค าส ง และการท างานของ โปรแกรมน น ๆ 2.2 ส วนท เป นค าอธ บายด านเทคน ค ม กท าเอกสารแยกต างหากออกจาก โปรแกรม ซ งจะอธ บายในรายละเอ ยดท มากข น เช นช อโปรแกรมย อยต าง ๆ ม อะไรบ าง แต ละโปรแกรมย อยทาหน าท อะไร นอกจากน นย งต องเข ยน คาอธ บายย อ ๆ เก ยวก บว ตถ ประสงค ของโปรแกรมน น

3 337 การจ ดทาเอกสารประกอบการทางาน ในระหว างเตร ยมต วต ดต งระบบใหม ให ก บองค กร หล งจากการทาการศ กษาว เคราะห และออกแบบจนได ระบบงานใหม ข นมาอย างสมบร ณ น กว เคราะห ระบบจะต องให ความ สนใจก บการจ ดทาเอกสารต างๆ ท จะให ผ ใช ระบบนาไปใช ในการอ างอ งเม อระบบงาน ได ถ กนาไปใช งานจร ง ซ งก ค อ ค ม อการใช ระบบ นอกจากน น กว เคราะห อาจจะต องจ ดให ม การอบรม (Training Program) เพ อเตร ยมความพร อมให ก บผ ใช ระบบด วย การจ ดทาเอกสารส าหร บผ ใช น กว เคราะห ระบบจะต องจ ดทาเอกสารซ งอธ บายรายละเอ ยดถ งการปฏ บ ต งานในระด บ ต างๆ ของระบบท กระด บ เอกสารสาหร บผ ใช ระบบงานสามารถแบ งออกเป น 3 ประเภท ค อ 1. ค ม อการใช 2. ค ม อการปฏ บ ต การ 3. เอกสารประกอบการฝ กอบรม ซ งเอกสารแต ละประเภทจะรองร บจ ดประสงค ท ใช อ างอ งแตกต างก นออกไป แต ม ข อท เหม อนก นอย างหน ง ค อ การจ ดเตร ยมเอกสารส าหร บผ ใช ระบบงาน ต องพยายามใช คาพ ดหร อคาศ พท ท ผ ใช ระบบงานท วไปเข าใจ พยายามหล กเล ยงการใช ศ พท เทคน คให มากท ส ดเท าท จะจาได หากจาเป นจะต องใช ศ พท เทคน ค ควรจะม คาอธ บายความหมาย ให ผ อ านได ทราบด วยเสมอ

4 338 ผ ใช ระบบงาน แบ งออกเป น 2 กล มใหญ ๆ ค อ ค ม อการใช 1. ผ ใช ท ไม ควรร เก ยวก บระบบ 2. ผ ใช ท ม ประสบการณ มาบ าง แต ต องใช เอกสารช วย เพ อค นหาข อม ลเม อ ต องการหาข อม ลบางอย างเป นบางคร งบางคราว เป นเอกสารส าหร บผ ใช ระบบงานท นาเสนอข อม ลการปฏ บ ต งานต างๆ ท ม อย ท งหมด ของระบบงานน น ค ม อการใช จะประกอบด วย ต วอย างหน าจอ (Screen Displays) ซ ง อธ บายว าผ ใช ระบบสามารถกรอกข อม ลลงในส วนใด หร อจะด ข อม ลประเภทน นๆ ได จากตาแหน งใดบนจอภาพ เป นต น ค ม อ ก า ร ใ ช จ ะ ท า ห น า ท อ ธ บ า ย แ น ะ น า ท า ง ใ ห ก บ ผ ใ ช ร ะ บ บ ท ล ะ ข น ต อ น ตามลาด บ เพ อให ผ ใช ระบบสามารถปฏ บ ต งานได อย างถ กต อง ข อผ ดพลาดท แสดงไว เป นข อความในระบบ Error Messages ท อาจจะเก ดข นในส วนต างๆ ของระบบซ งต ว ระบบงานได ด กเอาไว น น จะต องแสดงให ผ ใช ระบบทราบและบอกถ งความหมายของ ข อความน นๆ โดยละเอ ยดพร อมท งทาแนะนาว าผ ใช ระบบควรจะทาอย างไรต อไปด วย ค ม อการใช จ งเป นแหล งการศ กษาเบ องต นส าหร บผ ใช งานระบบใหม ท ย งไม ค นเคยก บ ระบบ ด งน นหากน กว เคราะห ระบบและท มงานจ ดทาเอกสารค ม อการใช ได ด แล ว ย อมจะส งผล ด ให ก บผ ใช ระบบยอมร บในต วระบบได ด ข นด วย และย งทาให ผ ใช ระบบสามารถ ปฏ บ ต งานได อย างม ประส ทธ ภาพอ กด วย

5 339 ค ม อการปฏ บ ต งาน เป นเอกสารท ถ กจ ดเตร ยมข นส าหร บพน กงานหร อท มงานคอมพ วเตอร เฉพาะ ด งน นจ ง จะค อนข างจะเก ยวโยงในด านเทคน คมากกว าค ม อการใช โดยท วไป ค ม อการปฏ บ ต งาน ประด วยห วข อต าง ๆ ด งน ค อ 1. สร ปข นตอนต าง ๆ ท งหมดของระบบ 2. Flowchart ของระบบงาน (Details System Flowchart) 3. ว ธ การจ ดต ดต งระบบ (Job Program Setup Instructions) 4. ข นตอนการสารองข อม ลและระบบงาน (Backup Procedure) 5. ข นตอนการเร ยกค นข อม ลเพ อนากล บมาใช ใหม (Recovery and Restart Procedure) การสร ปข นตอนต าง ๆ ท งหมดของระบบในค ม อปฏ บ ต งาน ประกอบด วย รายละเอ ยด ของข นตอนท สาค ญ ๆ Input และ Output ของแต ละข นตอนก ควรจะได ร บการอธ บายให ได ความส น ๆ แผนภาพแสดงการไหลของข อม ล (DFD) ควรนามาใช แสดงส าหร บ ข นตอนท สาค ญ ๆ ด วย Flowchart ของระบบควรจะแสดงให เห นในท ก ๆ ข นตอน และ ต วโปรแกรมต าง ๆ ควรม การจ ดพ มพ เอกสารออกมา พร อมช อแฟ มข อม ลหร อ ฐานข อม ลท ใช ด วยในบางกรณ ระบบงานจาเป นต องม การจ ดต งระบบ (Setup) ก อนซ ง รายละเอ ยดการจ ดต งระบบอาจ ประกอบด วย 1. การระบ ว าข อม ลส วนใดจะใช ในการทาออนไลน 2. แก ไขว นท ของโปรแกรม 3. แก ไขข อม ลท ระบบทาการเก บค าเอาไว ในคร งก อน 4. การจ ดเตร ยมพ นท ข นมาใหม 5. ว ธ การยกเล กแฟ มข อม ลในส วนของสารองข อม ลท ใช เด ม

6 ใส ข อม ลต างๆ ให ระบบได ร บทราบก อนท จะใช เช น จอภาพเป นชน ดใด รายละเอ ยดของการแสดงผลขนาดใด เคร องพ มพ เป นเคร องร นไหน หร อต วโปรแกรมอย ในไดเรอทอร ใด และแฟ มข อม ลอย ตาแหน งหร อไดเรอทอร ใดในพ นท หน วยความจา การส ารองข อม ลและการเร ยกค นข อม ลกล บมาเพ อใช ใหม เป นส งส าค ญอ กส งหน งท ระบบจะต องม เพ อให สามารถร สถานการณ ในกรณ ท เก ดข อผ ดพลาดข นใน ระบบ ในขณะท กาล งทาการปฏ บ ต การอย สร ป การเข ยนเอกสารประกอบโปรแกรม สามารถแบ งออกเป น 3 ส วนด วยก น ค อเอกสาร ประกอบส าหร บต วโค ดโปรแกรม เพ ออานวยความสะดวกแก ผ นาโค ดโปรแกรมไป พ ฒนาต อได อย างต อเน อง ส วนเอกสารประกอบส าหร บการใช งานโปรแกรม หร ออาจ เร ยกว าเป นค ม อในการใช โปรแกรม เป นเอกสารท สร างข นมาเพ อให การใช โปรแกรม ของผ ใช โปรแกรมได อย างม ประส ทธ ภาพส งส ดสามารถใช ได ท กฟ งก ช นหน าท ของ โปรแกรมท สร างข นมา ซ งค ม อการใช โปรแกรมต องถ กสร างข นมาโดยคาน งผ ใช งาน โปรแกรมไม ม ความร ในการการเข ยนโปรแกรมให สามารถอ านเข าใจง ายท ส ดและนามา โปรแกรมท สร างข นได งานได อย างรวดเร ว และเอกสารประกอบโปรแกรมส วนท สาม เป นเอกสารท สร างข นมาเพ อให ผ ท ม ความร พ นฐานคอมพ วเตอร ระด บเบ องต นสามารถ ต ดต งโปรแกรมหร อแก ไขป ญหาได ในกรณ ท ป ญหาไม ผลกระทบต อระบบปฏ บ ต การ ของคอมพ วเตอร และในเอกสารประกอบโปรแกรมส วนน ควรสร างกรณ ต วอย างป ญหา ท พบบ อยๆ พร อมข อแนะนาการแก ป ญหาเป นข อๆ ท ละข นตอนอย างระบบ เพ อสร าง ความม นใจให ก บผ ใช งานโปรแกรมว าโปรแกรมได ถ กออกแบบมาให ม ความเหมาะสม ก บการใช งานจร งๆ และม ความม นคงของระบบเป นอย างด เช อถ อได เป นต น

7 341 แบบฝ กห ดท ายบทท 13 ให ผ อ านเข ยนเอกสารประกอบโปรแกรมท ผ อ านสนใจ มา 1 เร อง โดยให ทาการ สร างมาเป นค ม อในการใช งานได จร ง